docs/development/Building in Mac OS X.md

   1 # Building in Mac OS X
   2
   3 Building in Mac OS X can be accomplished in just a few steps:
   4
   5 * Install general development tools (clang, make, git)
   6 * Checkout Betaflight sourcecode through git
   7 * Install ARM GCC compiler
   8 * Build the code
   9
  10 ## Install general development tools (clang, make, git)
  11
  12 Open up a terminal and run `make`. If it is installed already, you should see a message like this, which means that you
  13 already have the required development tools installed:
  14
  15 ```
  16 make: *** No targets specified and no makefile found.  Stop.
  17 ```
  18
  19 If it isn't installed yet, you might get a popup like this. If so, click the "install" button to install the commandline
  20 developer tools:
  21
  22 ![Prompt to install developer tools](assets/mac-prompt-tools-install.png)
  23
  24 If you just get an error like this instead of a helpful popup prompt:
  25
  26 ```
  27 -bash: make: command not found
  28 ```
  29
  30 Try running `xcode-select --install` instead to trigger the popup.
  31
  32 If that doesn't work, you'll need to install the XCode development environment [from the App Store][]. After
  33 installation, open up XCode and enter its preferences menu. Go to the "downloads" tab and install the
  34 "command line tools" package.
  35
  36 [from the App Store]: https://itunes.apple.com/us/app/xcode/id497799835
  37
  38 ## Checkout Betaflight sourcecode through git
  39
  40 Enter your development directory and clone the [Betaflight repository][] using the "HTTPS clone URL" which is shown on
  41 the right side of the Betaflight GitHub page, like so:
  42
  43 ```
  44 git clone https://github.com/betaflight/betaflight.git
  45 ```
  46
  47 This will download the entire betaflight repository for you into a new folder called "betaflight".
  48
  49 [Betaflight repository]: https://github.com/betaflight/betaflight
  50
  51 ## Install ARM GCC compiler
  52
  53 To install the needed compiler you just need to enter the betaflight directory and run `make arm_sdk_install`
  54
  55 ## Build the code
  56
  57 Enter the betaflight directory and run `make TARGET=BETAFLIGHTF4` to build firmware for the BETAFLIGHTF4. When the build completes,
  58 the .hex firmware should be available as `obj/betaflight_3.5.2_BETAFLIGHTF4.hex` for you to flash using the Betaflight
  59 Configurator.
  60
  61 ## Updating to the latest source
  62
  63 If you want to erase your local changes and update to the latest version of the Betaflight source, enter your
  64 betaflight directory and run these commands to first erase your local changes, fetch and merge the latest
  65 changes from the repository, then rebuild the firmware:
  66
  67 ```
  68 git reset --hard
  69 git pull
  70
  71 make clean TARGET=BETAFLIGHTF4
  72 make TARGET=BETAFLIGHTF4
  73 ```